<div id="editinfo"></div>
<div class="header">
<p>
Next: [[cvs: Loginfo#Loginfo|loginfo]], Previous: [[cvs: Verifying log messages#Verifying log messages|verifymsg]], Up: [[cvs: The commit support files#The commit support files|commit files]] &nbsp; |[[cvs: Index#SEC_Contents|Contents]]||[[cvs: Index#Index|Index]]|</p>
</div>

----

<div id="Editinfo"></div>
==== Editinfo ====
<div id="index-editinfo-_0028admin-file_0029"></div>
<div id="index-Editor_002c-specifying-per-module"></div>
<div id="index-Per_002dmodule-editor"></div>
<div id="index-Log-messages_002c-editing"></div>

'''Note: The &lsquo;<tt>editinfo</tt>&rsquo; feature has been
rendered obsolete.  To set a default editor for log
messages use the <code>CVSEDITOR</code>, <code>EDITOR</code> environment variables
(see [[cvs: All environment variables which affect CVS#All environment variables which affect CVS|Environment variables]]) or the &lsquo;<code>-e</code>&rsquo; global
option (see [[cvs: Global options#Global options|Global options]]).  See [[cvs: Verifying log messages#Verifying log messages|verifymsg]],
for information on the use of the &lsquo;<tt>verifymsg</tt>&rsquo;
feature for evaluating log messages.'''

If you want to make sure that all log messages look the
same way, you can use the &lsquo;<tt>editinfo</tt>&rsquo; file to
specify a program that is used to edit the log message.
This program could be a custom-made editor that always
enforces a certain style of the log message, or maybe a
simple shell script that calls an editor, and checks
that the entered message contains the required fields.

If no matching line is found in the &lsquo;<tt>editinfo</tt>&rsquo;
file, the editor specified in the environment variable
<code>$CVSEDITOR</code> is used instead.  If that variable is
not set, then the environment variable <code>$EDITOR</code>
is used instead.  If that variable is not
set a default will be used.  See [[cvs: Committing your changes#Committing your changes|Committing your changes]].

The &lsquo;<tt>editinfo</tt>&rsquo; file is often most useful together
with the &lsquo;<tt>rcsinfo</tt>&rsquo; file, which can be used to
specify a log message template.

Each line in the &lsquo;<tt>editinfo</tt>&rsquo; file consists of a
regular expression and a command-line template.  The
template must include a program name, and can include
any number of arguments.  The full path to the current
log message template file is appended to the template.

One thing that should be noted is that the &lsquo;<code>ALL</code>&rsquo;
keyword is not supported.  If more than one matching
line is found, the first one is used.  This can be
useful for specifying a default edit script in a
module, and then overriding it in a subdirectory.

<div id="index-DEFAULT-in-editinfo"></div>
If the repository name does not match any of the
regular expressions in this file, the &lsquo;<code>DEFAULT</code>&rsquo;
line is used, if it is specified.

If the edit script exits with a non-zero exit status,
the commit is aborted.

Note: when <small>CVS</small> is accessing a remote repository,
or when the &lsquo;<code>-m</code>&rsquo; or &lsquo;<code>-F</code>&rsquo; options to <code>cvs
commit</code> are used, &lsquo;<tt>editinfo</tt>&rsquo; will not be consulted.
There is no good workaround for this; use
&lsquo;<tt>verifymsg</tt>&rsquo; instead.

 [[cvs: Editinfo example#Editinfo example|&bull; editinfo example]]::            Editinfo example


----

<div class="header">
<p>
Next: [[cvs: Loginfo#Loginfo|loginfo]], Previous: [[cvs: Verifying log messages#Verifying log messages|verifymsg]], Up: [[cvs: The commit support files#The commit support files|commit files]] &nbsp; |[[cvs: Index#SEC_Contents|Contents]]||[[cvs: Index#Index|Index]]|</p>
</div>
This document was generated on <i>a sunny day</i> using [http://www.nongnu.org/texi2html/ <i>texi2html</i>].
